标签

代码规范

字数

211 字

阅读时间

1 分钟

功能模块

1、软件项目的定位，基本功能描述；

2、运行项目代码的方法，安装环境，启动方式命令等；

3、简明扼要的使用说明；

4、项目代码结构说明，更详细说明软件的原理；

5、常见问题说明，以及注意事项。

README 还要包含的一些内容：

1、项目和所有子类模块和所有库的名字；

2、如何使用；

3、版权和许可信息；

4、针对所有项目和其子类模块、库的描述信息；

5、安装、配置和运行程序的指引向导；

6、拉取最新代码和构建时候的说明；

7、提交的 bug、功能需求、补丁等介绍；